Vapi Std DynamicID

Vapi Std DynamicID
Vapi Std DynamicID

The Vapi Std DynamicID schema represents an identifier for a resource of an arbitrary type.

JSON Example
{
    "type": "string",
    "id": "string"
}
string
type
Required

The type of resource being identified (for example com.acme.Person).

Resources that contain operations for creating and deleting resources typically contain a constant specifying the resource type for the resources being created and deleted. The API metamodel metadata resources include a resource that allows retrieving all the known resource types.

string
id
Required

The identifier for a resource whose type is specified by Vapi Std DynamicID.type.

When clients pass a value of this schema as a parameter, the property type must contain the actual resource type. When operations return a value of this schema as a response, the property type will contain the actual resource type.